home *** CD-ROM | disk | FTP | other *** search
/ Video Toaster 4.0 / Video Toaster v4.0.iso / programs / documentation / editorarexx.doc < prev    next >
Text File  |  1995-03-10  |  10KB  |  385 lines
  1. Editor ARexx Documentation        Mar 10 1995
  2.  
  3. The Video Toaster's Editor interface is controlled through an entirely
  4. separate program, Edit.  It has its own ARexx port, which is configured as
  5. a function host.  The port name is PROJECT_REXX_PORT, and the functions
  6. it responds to are documented below.  Although arexx programs can be
  7. executed (asynchronously) from within a sequence, the editor itself is
  8. preoccupied with its sequencing duties, and will not respond to any rexx
  9. messages sent to it until after the sequence is done playing.  The upshot
  10. of this is that you must put your rexx croutons at the end of a sequence if
  11. you want them to talk to the editor. Have fun.
  12.  
  13.  
  14. "CROUTONNAME"    returns crouton name
  15.         ARGS:    [Row,Column]
  16.  
  17.  
  18. "CROUTONSPOT"    return position in grid for current crouton
  19.         ARGS: NONE
  20.  
  21.  
  22. "CROUTONTYPE"    Return Crouton Type
  23.         ARGS:    [coords]
  24.  
  25.  
  26. "CROUTONPICK"    Pick Crouton -- Selects Crouton
  27.         ARGS:    0 args ==> deselect allRow,Column or no args to
  28.         ARGS:    1 args ==> Number OR "FIRST" or "LAST"
  29.         ARGS:    2 args ==> Row,Column
  30.  
  31.  
  32. "CROUTONLOAD"    Load Crouton -- Adds named crouton to end of project
  33.         ARGS:    CroutonName
  34.  
  35.  
  36. "CROUTONRUN"    Run Crouton without adding to project
  37.         ARGS:    CroutonName
  38.  
  39.  
  40. "CROUTONSTOP"    Aborts currently playing crouton (clip)
  41.         ARGS:  none
  42.  
  43.  
  44. "CROUTONGETTAG"    Return Tag value, may be 0 if tag doesn't exist OR tag has value of 0
  45.         ARGS:    Tag name
  46.  
  47.  
  48. "CROUTONSETTAG"    Set crouton tag value
  49.         ARGS: Tag name, Value
  50.  
  51.  
  52. "CROUTONCHECKTAG"    Check existance of tag in crouton, return size
  53.         ARGS:    Tag name
  54.  
  55.  
  56. "PROJECTLOAD"    Load Project
  57.         ARGS:    Project name (full path)
  58.  
  59.  
  60. "PROJECTSAVE"    Save Project
  61.         ARGS:    Project name (full path)
  62.  
  63.  
  64. "PROJECTPLAY"    Play Project
  65.         ARGS:    none
  66.  
  67.  
  68. "FLYERDRIVE"    Return flyer drive name based on index in internal list, or ""
  69.         ARGS: Drive number, starting at 0
  70.  
  71.  
  72. "FLYERSTATUS"    Return flyer status/error code, useful for checking 
  73.     recording/playing or errors.  The codes are listed below.
  74.         ARGS: NONE
  75.  
  76.  
  77. "RECORDCLIP"    Record a named flyer clip, won't overwrite existing clip w/ same name
  78.         ARGS: ClipName [, # of Fields, Source, Compression Mode]
  79.             if fields=0, recording continues 'til drive is full omitting source 
  80.             or mode will use last selected mode, note that all clips must have
  81.             full flyer VOLUME name included.
  82.  
  83.  
  84. "RECORDPAUSE"    Pause Recording
  85.         ARGS: Pause=1 for Pause, 0 for resume
  86.  
  87.  
  88. "RECORDSTOP"    Stop Recording
  89.         ARGS: none
  90.  
  91.  
  92. "MAKEICON"  Create an icon for a flyer clip, optionally make 'Flyer Still'
  93.         icon for 4=field clips by adding 'STILL' keyword.
  94.         ARGS: ClipName [, Field, ['STILL'] ]
  95.  
  96.  
  97. "REQ_ERROR"    Display error message at top of screen
  98.         ARGS: String
  99.  
  100.  
  101. "REQ_NUMBER"    Put up number requester with optional min,max limits
  102.         ARGS: Title, [num,[min,[max]]]
  103.  
  104.  
  105. "REQ_STRING"    String requester
  106.         ARGS: Title, [String]
  107.  
  108.  
  109. "REQ_TELL"    Put up requester with title and up to 3 lines, return 1 or 0
  110.         ARGS: Title, [line1,[line2,[line3]]]
  111.  
  112.  
  113. "REQ_TIME"    Time code string requester -- alters/returns time string like 'HH:MM:SS:FF'
  114.         ARGS: Title, [time]
  115.  
  116.  
  117. "REQ_OPEN"    Open an asynchronous requester with title and up to 3 lines, return nothing
  118.         ARGS: Title, [line1,[line2,[line3]]]
  119.  
  120.  
  121. "REQ_CLOSE" Close asynchronous opened with REQ_OPEN
  122.         ARGS: NONE
  123.  
  124.  
  125. "STARTFILEREQ"    Open Grazer as file requester, use QUERYFILEREQ to query result
  126.         ARGS: Title, Initial path, Initial file
  127.  
  128.  
  129. "QUERYFILEREQ"    Return result of Grazer as file requester:
  130.                 "" if requester is up, 0 if canceled, or name
  131.         ARGS: NONE
  132.  
  133.  
  134. "CURRENTPATH"    Return current path in bottom grazer window, if any
  135.         ARGS: NONE
  136.  
  137.  
  138. "GETSCREEN"    Return editor/switcher screen address
  139.         ARGS: NONE
  140.  
  141.  
  142. "SET_VIEW"    Change views between project/files, project/Switcher, etc.
  143.         ARGS: View# 0-5 though 4 is not supported, 5 is no top window, a rexx-only mode
  144.  
  145.  
  146. "ADDPROGRAM"    Add a Name and command to 'Programs' popup
  147.     ARGS: Program Name(28 chars max), command string(127 chars max), flags
  148.         where:
  149.             Name appears in popup, runs command as either rexx or dos script
  150.             depending on flags bit 0 (i.e.  1 for ARexx, 0 for dos).  Returns
  151.             number in popup sequence.    N.B. The editor waits for Dos commands
  152.             to return, thus an app. that will not finish immediately should
  153.             be preceeded by the 'run' command.
  154.  
  155.  
  156. "REMPROGRAM" Remove user-program from 'Programs' popup
  157.         ARGS: program index (position in popup) as returned by Addprogram
  158.  
  159.  
  160. "PROGRAMCMD"    return user-program command string
  161.         ARGS: program index (position in popup) as returned by Addprogram
  162.  
  163.  
  164. "PROGRAMNAME"    return user-program name as it appears in Programs popup
  165.         ARGS: program index (position in popup) as returned by Addprogram
  166.  
  167. "PROGRAMNUM"    return program index (position in popup)
  168.         ARGS: User-program command string
  169.  
  170.  
  171. "TBC"    Adjust Flyer TBC settings
  172.         ARGS: Setting,[value] (if value is omitted, current setting is returned
  173.             Setting May be 1 of: (cap.s are min. abbrev.)
  174.                 Bright(-64 - 63), Contrast(0-127), Saturation(0-127),
  175.                 HUe(-64-63), Fader(0-255), Phase(0-2047),
  176.                 HorizAdj(0-909), Key(0-3), Mode(0-2)(for keyer),
  177.                 Encoder(0-15), Decoder(0-8),
  178.                 Termination(0-31), Input(0-3), Out(0,1)
  179.  
  180.  
  181. Here are the tag names you can use with the crouton tag commands.
  182. Internally, they correspond to ordered numbers which may have the first bit
  183. set to indicate whether the values are LONGs or variable length tables.
  184. The meaning of the tags should be evident from their names, and if they're
  185. not, that is a good indication that you shouldn't mess with them, and they
  186. probably won't do anything if you do.
  187.  
  188. Version
  189. Revision
  190. AAeffect
  191. NonAAeffect
  192. KillInterfaceNonAA
  193. KillInterfaceAA
  194. ButtonELHlogic
  195. CustomButtonELHlogic
  196. NumberOfAnims
  197. RequestFileName
  198. AnimFiles
  199. Frames
  200. FieldSync
  201. VariableSpeeds
  202. ForcePlayForward
  203. ForcePlayReverse
  204. LoopAnims
  205. AnimControl
  206. AudioFastSamples
  207. AudioMediumSamples
  208. AudioSlowSamples
  209. AudioFiles
  210. AudioControl
  211. PauseTimes
  212. LatchColors
  213. TransparentColors
  214. PaletteColors
  215. Equations
  216. Encoder
  217. VerticalScroll
  218. ReverseTime
  219. ReverseButtLog
  220. ReverseCustomButtLog
  221. KeyMode
  222. MatteColor
  223. CustomMatteColor
  224. BorderColor
  225. CustomBorderColor
  226. LineNumbers
  227. LineNumberPlane
  228. ForceFreeze4
  229. ForceFreeze8
  230. ForceLive
  231. ForceLumKeyOn
  232. ForceLumKeyOff
  233. ForceLumKeyOnBlack
  234. ForceLumKeyOnWhite
  235. BadDefaultFX
  236. LoadPictures
  237. FadeInDuration
  238. FadeOutDuration
  239. DigitalFX
  240. TimeMode
  241. LUT
  242. DigitalPairs
  243. LatchAM
  244. LatchBM
  245. LatchIS
  246. HonorPreviewOverLay
  247. ForceDefaultMatte
  248. TurnAudioFilterOff
  249. AudioStartField
  250. NumAudioFields
  251. ISandClipPause
  252. Interlaced
  253. FirstFieldNTSCII
  254. BounceILBM
  255. LatchRanges
  256. LatchList
  257. TransparentRanges
  258. TransparentList
  259. Color0Transparent
  260. AbortIfSlow
  261. NumSkipFieldsAtEnd
  262. TBarDoesAuto
  263. DoNotStompSprite
  264. AbortLoopAtEnd
  265. NonAAremap
  266. 100PercentWhiteMatte
  267. UseEffectColor
  268. LoopCount
  269. CroutonType
  270. TimeLine
  271. IndexID
  272. FCountMode
  273. VariableFCount
  274. SlowFCount
  275. MedFCount
  276. FastFCount
  277. VariableFCount68000
  278. SlowFCount68000
  279. MedFCount68000
  280. FastFCount68000
  281. NumFields
  282. StartTime
  283. DescriptorList
  284. AboutList
  285. CommentList
  286. AlgoFXtype
  287. AlgoFXborder
  288. NumFramesSlow
  289. NumFramesMedium
  290. NumFramesFast
  291. NumFramesVariable
  292. Page
  293. Speed
  294. Delay
  295. Duration
  296. AudioAttack
  297. AudioDecay
  298. RecFields
  299. AudioOn
  300. AudioStart
  301. AudioDuration
  302. ClipStartField
  303. FadeInVideo
  304. MaxDuration
  305. VideoSource
  306. LoadedSlices
  307. OriginalLocation
  308. AudioVolume1
  309. AudioVolume2
  310. AudioPan1
  311. AudioPan2
  312. PanelMode
  313. ColorMode
  314. CycleMode
  315. DataMode
  316. AdjustedVideoStart
  317. AdjustedVideoDuration
  318. Asynchronous
  319. CommandLine
  320. SMPTEtime
  321. TBarPosition
  322.  
  323.  
  324. Here are the Error codes returned by the FLYERSTATUS command.
  325.  
  326. /*** General Flyer Errors ***/
  327. #define    FERR_OKAY            0x00    /* All went well */
  328. #define    FERR_CMDFAILED        0x01    /* Command failed for some reason */
  329. #define    FERR_BUSY            0x02    /* Still in progress */
  330. #define    FERR_ABORTED        0x03    /* User abort */
  331. #define    FERR_BADPARAM        0x04    /* Bad command parameter */
  332. #define    FERR_BADCOMMAND    0x05    /* Command not defined/supported */
  333. #define    FERR_BADVIDHDR        0x06    /* Ran out of video - no header detected */
  334. #define    FERR_WRONGMODE        0x07    /* Wrong play/rec mode for action */
  335. #define    FERR_OLDDATA        0x08    /* Incompatible data */
  336. #define    FERR_NOAUDIOCHAN    0x09    /* No free audio channel(s) */
  337. #define    FERR_CHANINUSE        0x0A    /* Video/SCSI channel not available */
  338. #define    FERR_BADFLDHAND    0x0B    /* Bad field handle */
  339. #define    FERR_CLIPLATE        0x0C    /* A/V clip started late */
  340.  
  341. /*** Flyer Internal Errors ***/
  342. #define    FERR_NOTASKS        0x10    /* No SCSI tasks available for use */
  343. #define    FERR_LISTCORRUPT    0x11    /* Internal list corrupt */
  344. #define    FERR_NOTINRANGE    0x12    /* Internal list error */
  345. #define    FERR_EEFAILURE        0x13    /* EEPROM failure */
  346. #define    FERR_NOFINDERS        0x14    /* No FrameFinders available for use */
  347. #define    FERR_BADMODULE        0x1F    /* Incompatible module provided */
  348.  
  349. /*** FileSystem Errors ***/
  350. #define        FIRSTFSERR            0x20
  351. #define    FERR_OBJNOTFOUND    0x20    /* Could not find file/dir */
  352. #define    FERR_FULL            0x21    /* Drive full */
  353. #define    FERR_DIRFULL        0x22    /* Directory full */
  354. #define    FERR_EXHAUSTED        0x23    /* Directory list exhausted */
  355. #define    FERR_FSFAIL            0x24    /* FileSystem failure */
  356. #define    FERR_WRONGTYPE        0x25    /* Wrong type of object */
  357. #define    FERR_UNFORMATTED    0x26    /* Drive not high-level formatted */
  358. #define    FERR_EXCLUDED        0x27    /* Exclusive lock prevented action */
  359. #define    FERR_OUTOFRANGE    0x28    /* Seek beyond bounds */
  360. #define    FERR_CANTEXTEND    0x29    /* End of file, and cannot extend file */
  361. #define    FERR_PROTECTED        0x2A    /* Drive write-protected */
  362. #define    FERR_DIFFERENT        0x2B    /* Grips are different objects */
  363. #define    FERR_EXISTS            0x2C    /* File already exists */
  364. #define    FERR_NOMEM            0x2D    /* Out of storage */
  365. #define    FERR_DELPROT        0x2E    /* Delete-protected file */
  366. #define    FERR_READPROT        0x2F    /* Read-protected file */
  367. #define    FERR_WRITEPROT        0x30    /* Write-protected file */
  368. #define    FERR_INUSE            0x31    /* Disk/object in use */
  369. #define    FERR_DIRNOTEMPTY    0x32    /* Directory was not empty */
  370. #define        LASTFSERR            0x32
  371.  
  372. /*** SCSI Errors ***/
  373. #define    FERR_SELTIMEOUT    0x40    /* SCSI Time-out -- no drive */
  374. #define    FERR_BADSTATUS        0x41    /* Bad status after executing command */
  375.  
  376. /*** Amiga Library Errors ***/
  377. #define    FERR_NOCARD            0x70    /* Flyer card specified does not exist */
  378. #define    FERR_LIBFAIL        0x71    /* Library failed to pass command to Flyer */
  379. #define    FERR_ASYNCFAIL        0x72    /* An asynchronous command failed */
  380. #define    FERR_VOLNOTFOUND    0x73    /* Volume name not found */
  381. #define    FERR_NOFREECMD        0x74    /* Library<->Flyer RAM clogged */
  382. #define    FERR_BADID            0x75    /* Illegal async ID */
  383.  
  384. #define    FERR_LIMIT            0x7F
  385.